<!-- HTML header for doxygen 1.8.14-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Unity ML-Agents Toolkit: BrainParameters Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygenbase.css" rel="stylesheet" type="text/css" />
<link href="unity.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Unity ML-Agents Toolkit
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">BrainParameters Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Holds information about the brain.  
 <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a06d4cce02252835c0720d2ef207fde86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html">BrainParameters</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a06d4cce02252835c0720d2ef207fde86">Clone</a> ()</td></tr>
<tr class="memdesc:a06d4cce02252835c0720d2ef207fde86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deep clones the BrainParameter object.  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a06d4cce02252835c0720d2ef207fde86">More...</a><br /></td></tr>
<tr class="separator:a06d4cce02252835c0720d2ef207fde86"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abf10ed8f7ff513744bcadf366f746c09"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#abf10ed8f7ff513744bcadf366f746c09">VectorObservationSize</a> = 1</td></tr>
<tr class="memdesc:abf10ed8f7ff513744bcadf366f746c09"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of the observations that are added in <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html#a1c3586d1b95c619db2a9772f6818d44a" title="Implement CollectObservations() to collect the vector observations of the agent for the step.">Agent.CollectObservations(Sensors.VectorSensor)</a>  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#abf10ed8f7ff513744bcadf366f746c09">More...</a><br /></td></tr>
<tr class="separator:abf10ed8f7ff513744bcadf366f746c09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb5fe9721d10578d0635a1d4be23ece4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#adb5fe9721d10578d0635a1d4be23ece4">NumStackedVectorObservations</a> = 1</td></tr>
<tr class="memdesc:adb5fe9721d10578d0635a1d4be23ece4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stacking refers to concatenating the observations across multiple frames.  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#adb5fe9721d10578d0635a1d4be23ece4">More...</a><br /></td></tr>
<tr class="separator:adb5fe9721d10578d0635a1d4be23ece4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18e42527491da08310c44f3c9f24ae22"><td class="memItemLeft" align="right" valign="top">int[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a18e42527491da08310c44f3c9f24ae22">VectorActionSize</a> = new[] {1}</td></tr>
<tr class="memdesc:a18e42527491da08310c44f3c9f24ae22"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the action space.  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a18e42527491da08310c44f3c9f24ae22">More...</a><br /></td></tr>
<tr class="separator:a18e42527491da08310c44f3c9f24ae22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c7bd043670316784137cc0563705bc6"><td class="memItemLeft" align="right" valign="top">string[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a7c7bd043670316784137cc0563705bc6">VectorActionDescriptions</a></td></tr>
<tr class="memdesc:a7c7bd043670316784137cc0563705bc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The list of strings describing what the actions correspond to.  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a7c7bd043670316784137cc0563705bc6">More...</a><br /></td></tr>
<tr class="separator:a7c7bd043670316784137cc0563705bc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b84b0417518808f0939457b66ebe508"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Policies.html#a289d19b1eb0d908ce17b35be5e69b40b">SpaceType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a3b84b0417518808f0939457b66ebe508">VectorActionSpaceType</a> = <a class="el" href="namespaceUnity_1_1MLAgents_1_1Policies.html#a289d19b1eb0d908ce17b35be5e69b40ba4984667940802dedc139aa7a430a6553">SpaceType.Discrete</a></td></tr>
<tr class="memdesc:a3b84b0417518808f0939457b66ebe508"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defines if the action is discrete or continuous.  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#a3b84b0417518808f0939457b66ebe508">More...</a><br /></td></tr>
<tr class="separator:a3b84b0417518808f0939457b66ebe508"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:ad030346fc547784546d3a13eb0bf19f8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#ad030346fc547784546d3a13eb0bf19f8">NumActions</a><code> [get]</code></td></tr>
<tr class="memdesc:ad030346fc547784546d3a13eb0bf19f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The number of actions specified by this Brain.  <a href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html#ad030346fc547784546d3a13eb0bf19f8">More...</a><br /></td></tr>
<tr class="separator:ad030346fc547784546d3a13eb0bf19f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds information about the brain. </p>
<p>It defines what are the inputs and outputs of the decision process.</p>
<p>Set brain parameters for an <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html" title="An agent is an actor that can observe its environment, decide on the best course of action using thos...">Agent</a> instance using the </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BehaviorParameters.html" title="A component for setting an Agentinstance&#39;s behavior and brain properties.">BehaviorParameters</a></dd></dl>
<p>component attached to the agent's <a href="https://docs.unity3d.com/Manual/GameObjects.html">GameObject</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a06d4cce02252835c0720d2ef207fde86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06d4cce02252835c0720d2ef207fde86">&#9670;&nbsp;</a></span>Clone()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html">BrainParameters</a> Clone </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Deep clones the BrainParameter object. </p>
<dl class="section return"><dt>Returns</dt><dd>A new BrainParameter object with the same values as the original.</dd></dl>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="adb5fe9721d10578d0635a1d4be23ece4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb5fe9721d10578d0635a1d4be23ece4">&#9670;&nbsp;</a></span>NumStackedVectorObservations</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int NumStackedVectorObservations = 1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stacking refers to concatenating the observations across multiple frames. </p>
<p>This field indicates the number of frames to concatenate across.</p>

</div>
</div>
<a id="a7c7bd043670316784137cc0563705bc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c7bd043670316784137cc0563705bc6">&#9670;&nbsp;</a></span>VectorActionDescriptions</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string [] VectorActionDescriptions</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The list of strings describing what the actions correspond to. </p>

</div>
</div>
<a id="a18e42527491da08310c44f3c9f24ae22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18e42527491da08310c44f3c9f24ae22">&#9670;&nbsp;</a></span>VectorActionSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int [] VectorActionSize = new[] {1}</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The size of the action space. </p>
<p>The size specified is interpreted differently depending on whether the agent uses the continuous or the discrete action space.</p>
<p>For the continuous action space: the length of the float vector that represents the action. For the discrete action space: the number of branches in the action space. </p>

</div>
</div>
<a id="a3b84b0417518808f0939457b66ebe508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b84b0417518808f0939457b66ebe508">&#9670;&nbsp;</a></span>VectorActionSpaceType</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Policies.html#a289d19b1eb0d908ce17b35be5e69b40b">SpaceType</a> VectorActionSpaceType = <a class="el" href="namespaceUnity_1_1MLAgents_1_1Policies.html#a289d19b1eb0d908ce17b35be5e69b40ba4984667940802dedc139aa7a430a6553">SpaceType.Discrete</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Defines if the action is discrete or continuous. </p>

</div>
</div>
<a id="abf10ed8f7ff513744bcadf366f746c09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abf10ed8f7ff513744bcadf366f746c09">&#9670;&nbsp;</a></span>VectorObservationSize</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int VectorObservationSize = 1</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The number of the observations that are added in <a class="el" href="classUnity_1_1MLAgents_1_1Agent.html#a1c3586d1b95c619db2a9772f6818d44a" title="Implement CollectObservations() to collect the vector observations of the agent for the step.">Agent.CollectObservations(Sensors.VectorSensor)</a> </p>
<p>The length of the vector containing observation values. </p>

</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="ad030346fc547784546d3a13eb0bf19f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad030346fc547784546d3a13eb0bf19f8">&#9670;&nbsp;</a></span>NumActions</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">int NumActions</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>The number of actions specified by this Brain. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Policies_2BrainParameters_8cs.html">Policies/BrainParameters.cs</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.14-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespaceUnity.html">Unity</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents.html">MLAgents</a></li><li class="navelem"><a class="el" href="namespaceUnity_1_1MLAgents_1_1Policies.html">Policies</a></li><li class="navelem"><a class="el" href="classUnity_1_1MLAgents_1_1Policies_1_1BrainParameters.html">BrainParameters</a></li>
  </ul>
</div>
</body>
</html>
